[beta] Get custom report runs

Get custom report runs created by the user.

Rate limit: 5 requests/sec (learn more about rate limits here).

To use this endpoint, select Read Custom Reports under the Custom Reports category when creating or editing an API token. Learn More.

Submit Feedback: Likes, dislikes, and API feature requests should be filed as feedback in our API feedback form. If you encountered an issue or noticed inaccuracies in the API documentation, please submit a case to our support team.

GET /reports/runs

[beta] Get custom report runs

cURL

curl --request GET \
  --url https://api.samsara.com/reports/runs \
  --header 'Authorization: Bearer <token>'

200

{
  "data": [
    {
      "createdAtTime": "2019-06-13T19:08:25Z",
      "id": "4f71fd67-54f0-41de-991c-ee1e031134d1",
      "status": "complete",
      "updatedAtTime": "2019-06-13T19:08:25Z"
    }
  ],
  "pagination": {
    "endCursor": "MjkY",
    "hasNextPage": true
  }
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

reportConfigIds · string[]

The list of report config IDs to retrieve the report runs for. Include up to 10 report config IDs. If not provided, runs for all configs will be returned.

ids · string[]

The list of report run IDs to retrieve the report runs for. Include up to 10 report run IDs. If not provided, all report runs will be returned.

after · string

If specified, this should be the endCursor value from the previous page of results. When present, this request will return the next page of results that occur immediately after the previous page of results.

limit · integer · default: 100

Maximum number of runs to return.

Required range: 1 <= x <= 100

Response

200

application/json

OK response.

data · object[] · required

Array of report run objects.

Show child attributes

pagination · object · required

Pagination parameters.

Show child attributes